sys/xtimer: improve documentation #19681
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maribu
added
Type: bug
github-actions
bot
added
Area: sys
benpicco
approved these changes
May 30, 2023
|
bors merge |
bors bot
added a commit
that referenced
this pull request
May 30, 2023
19677: boards/nucleo-l432k: provide three periph_timer instances r=maribu a=maribu ### Contribution description - `cpu/stm32/periph_timer`: Generalize to also work with timers that do not have 4 channels - `boards/common/stm32`: Add timer config for three timers based on TIM2, TIM15, and TIM16 (the three general-purpose timers of the STM32L4) - `boards/nucleo-l432kc`: Make use of the new timer config 19681: sys/xtimer: improve documentation r=maribu a=maribu ### Contribution description - Add a warning that xtimer is deprecated, so that new code hopefully starts using ztimer - Add a hint that `ztimer_xtimer_compat` can be used even after `xtimer` is gone Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de>
|
This PR was included in a batch that was canceled, it will be automatically retried |
bors bot
added a commit
that referenced
this pull request
May 30, 2023
19677: boards/nucleo-l432k: provide three periph_timer instances r=maribu a=maribu ### Contribution description - `cpu/stm32/periph_timer`: Generalize to also work with timers that do not have 4 channels - `boards/common/stm32`: Add timer config for three timers based on TIM2, TIM15, and TIM16 (the three general-purpose timers of the STM32L4) - `boards/nucleo-l432kc`: Make use of the new timer config 19678: gnrc_sixlowpan_iphc: fix NULL pointer dereference r=maribu a=miri64 19681: sys/xtimer: improve documentation r=maribu a=maribu ### Contribution description - Add a warning that xtimer is deprecated, so that new code hopefully starts using ztimer - Add a hint that `ztimer_xtimer_compat` can be used even after `xtimer` is gone Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de> Co-authored-by: Martine Lenders <m.lenders@fu-berlin.de>
|
Build failed (retrying...): |
miri64
reviewed
May 30, 2023
sys/include/xtimer.h
Outdated
| * | ||
| * The implementation takes one low-level timer and multiplexes it. | ||
| * | ||
| * Insertion and removal of timers has O(n) complexity with (n) being the | ||
| * number of active timers. The reason for this is that multiplexing is | ||
| * realized by next-first singly linked lists. | ||
| * | ||
| * @warning xtimer has been deprecated in favor of the @ref sys_ztimer |
There was a problem hiding this comment.
Why not use the @deprecated command?
There was a problem hiding this comment.
This way it will show up in https://doc.riot-os.org/deprecated.html
- Add a deprecation note to xtimer, so that new code hopefully starts using ztimer - Add a hint that `ztimer_xtimer_compat` can be used even after `xtimer` is gone
maribu
force-pushed
the
xtimer_documentation
branch
from
4333ed7 to
9454a50
Compare
|
Canceled. |
|
bors merge |
bors bot
added a commit
that referenced
this pull request
May 30, 2023
19610: drivers/periph/rtc: improve doc on rtc_set_alarm r=maribu a=maribu ### Contribution description - point out behavior on denormalized time stamps - use errno codes to indicate errors (and adapt the few instances of actual error handling to use them) 19670: cpu/stm32: stm32f4 BRR from BSRR r=maribu a=kfessel ### Contribution description sometimes one wants to save one instruction :) just write the bits we need to write. ### Testing procedure tests/periph/gpio_ll tests this ### Issues/PRs references `@maribu` might know some reference maybe #19407 19678: gnrc_sixlowpan_iphc: fix NULL pointer dereference r=maribu a=miri64 19679: gnrc_sixlowpan_frag_sfr: fix ARQ scheduler race-condition r=maribu a=miri64 19680: gnrc_sixlowpan_frag_rb: fix OOB write in _rbuf_add r=maribu a=miri64 19681: sys/xtimer: improve documentation r=maribu a=maribu ### Contribution description - Add a warning that xtimer is deprecated, so that new code hopefully starts using ztimer - Add a hint that `ztimer_xtimer_compat` can be used even after `xtimer` is gone Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de> Co-authored-by: Karl Fessel <karl.fessel@ovgu.de> Co-authored-by: Martine Lenders <m.lenders@fu-berlin.de>
|
bors cancel |
|
Canceled. |
|
Build succeeded! The publicly hosted instance of bors-ng is deprecated and will go away soon. If you want to self-host your own instance, instructions are here. If you want to switch to GitHub's built-in merge queue, visit their help page. |
|
Nevermind, did not realize doc.riot-os.org was still in the old state. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
ztimer_xtimer_compatcan be used even afterxtimeris goneTesting procedure
Read the doc preview generated by the CI.
Issues/PRs references
Fixes #19667